﻿//-----------------------------------------------------------------------
// <copyright file="UIModule.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace App.Modules.UI
{
    using System;
    using System.Windows.Forms;
    using App.Modules.Component;
    using App.Modules.Editor;
    using App.Modules.Message;
    using App.Modules.Render;
    using TileTool.Log;
    using TileTool.UI.MainWindow;

    /// <summary>
    /// Module which handles all UI reated things.
    /// </summary>
    public class UIModule : Module
    {
        #region Constants - Private

        /// <summary>
        /// Log message group.
        /// </summary>
        private const string LogGroup = "UIModule";

        #endregion

        #region Fields - Private

        /// <summary>
        /// Factory used to create the main window.
        /// 
        /// Is set in Startup() and cleared in CreateMainWindow() since
        /// we should only create a single main window.
        /// </summary>
        private MainWindowFactoryComponentBase mainWindowFactory;

        #endregion

        #region Methods - Public

        /// <summary>
        /// Called when the application is starting up.
        /// </summary>
        public override void Startup()
        {
            LogSystem.LogStartup(LogGroup, "Starting...");

            ComponentModule component = GetModule<ComponentModule>();

            LogSystem.LogStartup(LogGroup, "Getting main window factory component...");
            this.mainWindowFactory = component.Get<MainWindowFactoryComponentBase>(ComponentAliases.MainWindow);

            base.Startup();
        }

        /// <summary>
        /// Called when the application is shutting down.
        /// </summary>
        public override void Shutdown()
        {
            base.Shutdown();
        }

        /// <summary>
        /// Create the application's main window.
        /// </summary>
        /// <returns>Returns the form for the application's main window.</returns>
        public Form CreateMainWindow()
        {
            if (this.mainWindowFactory == null)
            {
                throw new InvalidOperationException("Main window factory must be non-null. CreateMainWindow() was called twice.");
            }

            LogSystem.LogStartup(LogGroup, "Allocating main window...");

            MainWindowCreateData createData = new MainWindowCreateData();
            RenderModule renderModule = GetModule<RenderModule>();
            MessageModule messageModule = GetModule<MessageModule>();
            EditorModule editorModule = GetModule<EditorModule>();

            createData.Canvas = renderModule.Canvas;
            createData.Router = messageModule.MessageRouter;
            createData.State = editorModule.State;

            try
            {
                return this.mainWindowFactory.Allocate(createData);
            }
            finally
            {
                // So we always null this out.
                this.mainWindowFactory = null;
            }
        }

        #endregion
    }
}
